Skip to main content
Feedback

API Service OData tab

The API Service OData tab enables you to configure the API service's OData API and to generate and configure its OData entities. If you do not have any OData entities defined, the system prompts you to create one.

OData Configuration screen.

note

You can generate endpoints from processes by clicking Import an Endpoint in the component and selecting the processes. The process’s Web Services Server connector’s Listen action determines the default settings for the specified operations.

OData entities

The root of the profile is an entity type that must have at least one simple child element you can use for a key. The key can only be an integer data type.

Name
Description

Path to OData
Shows the relative path for the OData entity, which the complete path incorporates (along with the Base API Path from the General tab) when the web server is deployed to an runtime. The runtime provides the base URL.

Actions
Click the Main ic gear black a176 436a 86ca Actions icon to either edit or delete the entity.

Allowed Actions
These OData actions are available for each entity:

  • Get Entities

  • Get Entity By Key

Process
Shows the Web Services Server listener process linked to this entity.

Query Passthrough
For Get Entities Action, OData client processes pass query filters as payloads in requests for the action when selected.

Entity Description
Description of the OData entity.

On this Page